<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::gpu::DeviceMemory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><b>gpu</b></li><li class="navelem"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html">DeviceMemory</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classfaiss_1_1gpu_1_1DeviceMemory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">faiss::gpu::DeviceMemory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Manages temporary memory allocations on a GPU device.  
 <a href="classfaiss_1_1gpu_1_1DeviceMemory.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="DeviceMemory_8h_source.html">DeviceMemory.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::gpu::DeviceMemory:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classfaiss_1_1gpu_1_1DeviceMemory.png" usemap="#faiss::gpu::DeviceMemory_map" alt=""/>
  <map id="faiss::gpu::DeviceMemory_map" name="faiss::gpu::DeviceMemory_map">
<area href="classfaiss_1_1gpu_1_1StackDeviceMemory.html" alt="faiss::gpu::StackDeviceMemory" shape="rect" coords="0,56,188,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1a3f8580febe15b3eee91cc95bdb9c80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a3f8580febe15b3eee91cc95bdb9c80"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html#a1a3f8580febe15b3eee91cc95bdb9c80">getDevice</a> () const =0</td></tr>
<tr class="memdesc:a1a3f8580febe15b3eee91cc95bdb9c80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the device we are managing memory for. <br/></td></tr>
<tr class="separator:a1a3f8580febe15b3eee91cc95bdb9c80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4adf60b9a0561e6319aa5cb7f42558d7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">DeviceMemoryReservation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html#a4adf60b9a0561e6319aa5cb7f42558d7">getMemory</a> (cudaStream_t stream, size_t size)=0</td></tr>
<tr class="separator:a4adf60b9a0561e6319aa5cb7f42558d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5840a1e8578b28647a8649a4500a197d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5840a1e8578b28647a8649a4500a197d"></a>
virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html#a5840a1e8578b28647a8649a4500a197d">getSizeAvailable</a> () const =0</td></tr>
<tr class="memdesc:a5840a1e8578b28647a8649a4500a197d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current size available without calling cudaMalloc. <br/></td></tr>
<tr class="separator:a5840a1e8578b28647a8649a4500a197d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35640c7cd2d5be8a95c4e841f02c3f3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35640c7cd2d5be8a95c4e841f02c3f3e"></a>
virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html#a35640c7cd2d5be8a95c4e841f02c3f3e">toString</a> () const =0</td></tr>
<tr class="memdesc:a35640c7cd2d5be8a95c4e841f02c3f3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string containing our current memory manager state. <br/></td></tr>
<tr class="separator:a35640c7cd2d5be8a95c4e841f02c3f3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a908f5dad096de49eed81af60258c4655"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1DeviceMemory.html#a908f5dad096de49eed81af60258c4655">getHighWaterCudaMalloc</a> () const =0</td></tr>
<tr class="separator:a908f5dad096de49eed81af60258c4655"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aef8dd4a2717b716f1ea9288114a7c750"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef8dd4a2717b716f1ea9288114a7c750"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>returnAllocation</b> (<a class="el" href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">DeviceMemoryReservation</a> &amp;m)=0</td></tr>
<tr class="separator:aef8dd4a2717b716f1ea9288114a7c750"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a528af300081b2a36c0b8dbd9833e6f74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a528af300081b2a36c0b8dbd9833e6f74"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>DeviceMemoryReservation</b></td></tr>
<tr class="separator:a528af300081b2a36c0b8dbd9833e6f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages temporary memory allocations on a GPU device. </p>

<p>Definition at line <a class="el" href="DeviceMemory_8h_source.html#l00046">46</a> of file <a class="el" href="DeviceMemory_8h_source.html">DeviceMemory.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a908f5dad096de49eed81af60258c4655"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t faiss::gpu::DeviceMemory::getHighWaterCudaMalloc </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the high-water mark of cudaMalloc allocations for our device </p>

<p>Implemented in <a class="el" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ad1659533968bccdb288b1682e7feb234">faiss::gpu::StackDeviceMemory</a>.</p>

</div>
</div>
<a class="anchor" id="a4adf60b9a0561e6319aa5cb7f42558d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">DeviceMemoryReservation</a> faiss::gpu::DeviceMemory::getMemory </td>
          <td>(</td>
          <td class="paramtype">cudaStream_t&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Obtains a temporary memory allocation for our device, whose usage is ordered with respect to the given stream. </p>

<p>Implemented in <a class="el" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a9d9a5dcdb2d016cf00d14b8831db638b">faiss::gpu::StackDeviceMemory</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="DeviceMemory_8h_source.html">DeviceMemory.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="DeviceMemory_8cpp_source.html">DeviceMemory.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
